Collapses or expands a window to its title bar .

OSStatus CollapseWindow (
    WindowRef window, 
    Boolean collapse
);

Parameter descriptions

window

A pointer to a window.

collapse

Indicates whether the window should be collapsed or expanded.

function result

A result code.

DISCUSSION

The CollapseWindow function tells the Window Manager to collapse or expand a window depending upon the value passed in the inCollapseIt parameter. Only window definition functions that return the feature bit kWindowCanCollapse in response to a kWindowGetFeatures message support this function; see GetWindowFeatures.

VERSION NOTES

This function is available with Appearance Manager 1.0 and later.

AVAILABILITY

Supported in Carbon. Available in Carbon 1.0.2 and later when running Mac OS 8.1 or later.

© 2000 Apple Computer, Inc. (Last Updated 6/30/2000)